Skip to main content

SyncNow App Configuration

SyncNow has two configuration files, such as backend services configuration and frontend configuration. During installation these files are set with defaults.

Backend Services Configuration

Backend configuration file defines logging, database connectivity and HTTP/S connectivity. appsettings.json configuration file is located at the root of SyncNow Installation.

We strongly recommend using HTTPS TLS communication with SyncNow.

Environment Variables

Refer to Environment Variables Configuration Parameters for all environment variables.

SyncNow App Configuration Reference

This document describes the structure and options available in the appsettings.json configuration file for SyncNow. All sensitive values (such as passwords) have been removed, and example hosts are used for demonstration.

Example appsettings.json

{
  "Logging": {
    "LogLevel": {
      // System logging level. Use "Debug" for more detailed logs.
      "Default": "Information",
      "System": "Warning",
      "Microsoft": "Warning"
    }
  },
  "Settings": {
    "DatabaseConfiguration": {
      // Database type: valid values are "SQLLite", "SQLServer", "PostgreSQL"
      "DatabaseType": "SQLLite",
      // Database connection timeout in seconds
      "Timeout": 60,
      // The following values are valid for SQLServer and PostgreSQL only:
      "Server": "db-server", // Database server hostname
      "Port": 5432,            // Database port
      "Username": "syncnowuser", // Database username
      // "Password": "",        // Password removed for security
      "WindowsAuth": false,    // Use Windows authentication (SQL Server only)
      "TransportEncrypt": false, // Enable database transport encryption
      "Database": "SyncNow",   // Database name
      // For SQLLite only:
      "File": "./Database/SyncNow.db" // Path to SQLite database file
    }
  },
  "Kestrel": {
    // SyncNow TCP Port connections
    "Endpoints": {
      "Http": {
        // HTTP endpoint (not encrypted). Remove if not behind a secure proxy.
        "Url": "http://localhost:5030"
      },
      "Https": {
        // HTTPS endpoint (encrypted)
        "Url": "https://localhost:5031",
        "Protocols": "Http1",
        "Certificate": {
          // Path to your TLS certificate in PFX format
          "Path": "syncnowapp.pfx"
          // "Password": "..." // Certificate password removed for security
        }
      }
    }
  }
}

Configuration Sections

Logging

  • LogLevel: Controls the verbosity of logs for different components. Set to "Debug" for troubleshooting.

Settings > DatabaseConfiguration

  • DatabaseType: Choose between "SQLLite", "SQLServer", or "PostgreSQL".
  • Timeout: Connection timeout in seconds.
  • Server/Port: Host and port for the database server (not used for SQLite).
  • Username: Database user name.
  • WindowsAuth: Use Windows authentication (SQL Server only).
  • TransportEncrypt: Enable encryption for database connections.
  • Database: Name of the database.
  • File: Path to the SQLite database file (used only if DatabaseType is "SQLLite").

Kestrel

  • Endpoints.Http.Url: HTTP endpoint (not encrypted). Remove if not behind a secure proxy.
  • Endpoints.Https.Url: HTTPS endpoint (encrypted).
  • Endpoints.Https.Certificate.Path: Path to the TLS certificate in PFX format.

Note:

  • Always use HTTPS in production environments.
  • Do not store passwords or sensitive information in plain text.
  • Adjust hostnames and ports as needed for your deployment.

Frontend Configuration

app.json configuration file is located at the WebApp folder under the root of SyncNow Installation.

{
"apiEndpoint": "http://localhost:5030" set here backend full url including the http scheme
}